All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.movies.AtomContainer

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.util.QTHandleRef
                   |
                   +----quicktime.std.movies.AtomContainer

public class AtomContainer

extends QTHandleRef

implements QuickTimeLib, QuickTimeVRLib

AtomContainer()

Create a new disposable AtomContainer.

copyAtom(Atom)

This method allows a complete copy of an atom and all of its children to be extracted from its container and be placed in an new atom data structure.

copyAtomDataToHandle(Atom)

This method returns a leaf atom's data.

copyAtomDataToPtr(Atom, boolean, QTPointer)

This method returns a leaf atom's data to the buffer pointed to by the data object.

countChildrenOfType(Atom, int)

This method allows you to determine the number of items of a given type in a parent atom's child list.

findChildByID_Atom(Atom, int, int)

This method allows you to search for a particular atom within an atom's child list.

findChildByID_index(Atom, int, int)

This method allows you to search for a particular atom within an atom's child list.

findChildByIndex_Atom(Atom, int, int)

This method allows you to search for a particular atom within an atom's child list.

findChildByIndex_id(Atom, int, int)

This method allows you to search for a particular atom within an atom's child list.

fromCompressionDialog(CompressionDialog)

Retrieves the current configuration from the dialog

QuickTime::SCGetSettingsAsAtomContainer()

fromGraphicsImporterExportImage(GraphicsImporter)

Returns information about available export formats.

fromGraphicsImporterExportSettings(GraphicsImporter)

Returns the Export settings as an Atom Container.

fromGraphicsImporterMIME(GraphicsImporter)

Returns a list of MIME types supported by the graphics import component.

fromMediaInput(Media)

This method returns you the input map of the media.

fromMediaProperty(Media)

Retrieves the properties from a media handler.

fromMovieExporter(MovieExporter)

Retrieves the current settings from the movie export component..

fromMovieImporterMIME(MovieImporter)

Returns a list of MIME types supported by the movie import component.

fromMovieImporterSettings(MovieImporter)

Retrieves the current settings from the movie import component..

fromQTHandle(QTHandleRef)

This converts a QTHandle based object into an AtomContainer.

fromQTVRInstanceNode(QTVRInstance, int)

You can use the QTVRGetNodeInfo function to get the node information atom container that describes a node and all the hot spots in the node.

fromQTVRInstanceWorld(QTVRInstance)

The QTVRGetVRWorld function returns an atom container that contains general scene information about the QuickTime VR movie specified, as well as a list of all the nodes in that movie.

fromThreeDMediaHandlerObject(ThreeDMediaHandler)

No QT Documentation.

fromThreeDMediaHandlerRenderer(ThreeDMediaHandler)

No QT Documentation.

getAtomData(Atom)

Retrieves a pointer to the atom data for the specifiec leaf atom.

getAtomID(Atom)

This method returns the id of a given atom.

getAtomType(Atom)

This method returns the type of a given atom.

getNextChildType(Atom, int)

This method allows you to retrieve the next atom data type in a specified atom's child list.

insertChild(Atom, int, int, int)

This method creates a new empty child atom for parentAtom.

insertChild(Atom, int, int, int, int)

This method creates a new child atom for parentAtom.

insertChild(Atom, int, int, int, QTByteObject)

This method creates a new child atom for parentAtom.

insertChild(Atom, int, int, int, QTHandleRef)

This method creates a new child atom for parentAtom.

insertChild(Atom, int, int, int, QTPointerRef)

This method creates a new child atom for parentAtom.

insertChild(Atom, int, int, int, short)

This method creates a new child atom for parentAtom.

insertChildren(Atom, AtomContainer)

This method inserts all of the atoms in childrenContainer as child atoms of the atom specified by the parentAtom.

iTextAddString(Atom, int, String)

No QT Documentation.

iTextGetString(Atom, int)

No QT Documentation.

iTextRemoveString(Atom, int, int)

No QT Documentation.

nextChildAnyType(Atom, Atom)

This method allows you to retrieve all of a parent atom's children one by one, regardless of their type's and id's.

removeAtom(Atom)

This method removes an atom and all of its children from an atom data structure.

removeChildren(Atom)

This method removes all of the children of an atom.

replaceAtom(Atom, AtomContainer, Atom)

This method replaces an atom and all of its children with a different atom and all of its children.

setAtomData(Atom, int)

This method allows you to set a leaf atom's data.

setAtomData(Atom, QTByteObject)

This method allows you to set a leaf atom's data.

setAtomData(Atom, QTHandleRef)

This method allows you to set a leaf atom's data.

setAtomData(Atom, QTPointerRef)

This method allows you to set a leaf atom's data.

setAtomData(Atom, short)

This method allows you to set a leaf atom's data.

setAtomID(Atom, int)

This method allows you to change the ID of an atom.

swapAtoms(Atom, Atom)

This method swaps two atoms within an atomData structure.

 public AtomContainer() throws QTException

Create a new disposable AtomContainer.

QuickTime::QTNewAtomContainer

 public static AtomContainer fromQTVRInstanceWorld(QTVRInstance ins) throws QTVRException

The QTVRGetVRWorld function returns an atom container that contains general scene information about the QuickTime VR movie specified, as well as a list of all the nodes in that movie.

QuickTime::QTVRGetVRWorld

Returns:

the VRWorld AtomContainer

See Also:

getVRWorld

 public static AtomContainer fromQTVRInstanceNode(QTVRInstance ins,
                                                  int nodeID) throws QTVRException

You can use the QTVRGetNodeInfo function to get the node information atom container that describes a node and all the hot spots in the node.

QuickTime::QTVRGetNodeInfo

Parameters:

nodeID - Set this parameter to kQTVRCurrentNode to receive information about the current node

Returns:

an atom container that contains information about the specified node.

See Also:

getNodeInfo

 public static AtomContainer fromQTHandle(QTHandleRef handle)

This converts a QTHandle based object into an AtomContainer. This call does not make a copy of the handle, but allows you to access the handles data as if it were an AtomContainer, thus any changes you make to returned AtomContainer will be made to the handle itself. Essentially this allows you to view and change the contents of a handle with the assumption that it is an AtomContainer.

Parameters:

handle - the handle to convert to an AtomContainer.

Returns:

an AtomContainer

 public static AtomContainer fromGraphicsImporterMIME(GraphicsImporter gi) throws StdQTException

Returns a list of MIME types supported by the graphics import component.

QuickTime::GraphicsImportGetMIMETypeList

Returns:

a QT atom container that contains a list of MIME types supported by the graphics import component.

See Also:

getMIMETypeList

 public static AtomContainer fromGraphicsImporterExportImage(GraphicsImporter gi) throws StdQTException

Returns information about available export formats.

QuickTime::GraphicsImportGetExportImageTypeList

Returns:

a QT atom container that contains a list of available export formats. supported by the graphics import component.

See Also:

getExportImageTypeList

 public static AtomContainer fromGraphicsImporterExportSettings(GraphicsImporter gi) throws StdQTException

Returns the Export settings as an Atom Container.

QuickTime::GraphicsImportGetExportSettingsAsAtomContainer

Returns:

a QT atom container that contains Export settings.

See Also:

getExportSettingsAsAtomContainer

 public static AtomContainer fromMediaInput(Media m) throws StdQTException

This method returns you the input map of the media.

QuickTime::GetMediaInputMap()

Returns:

an AtomContainer object for media's input map.

See Also:

getInputMap

 public static AtomContainer fromMediaProperty(Media m) throws StdQTException

Retrieves the properties from a media handler.

QuickTime::GetMediaPropertyAtom()

Returns:

Contains the property atoms for the track associated with the media handler.

See Also:

getPropertyAtom

 public static AtomContainer fromMovieExporter(MovieExporter me) throws StdQTException

Retrieves the current settings from the movie export component..

QuickTime::MovieExportGetSettingsAsAtomContainer

Returns:

an AtomContainer with the current settings.

See Also:

getExportSettingsFromAtomContainer

 public static AtomContainer fromMovieImporterMIME(MovieImporter mi) throws StdQTException

Returns a list of MIME types supported by the movie import component.

QuickTime::MovieImportGetMIMETypeList

Returns:

an AtomContainer that contains a list of MIME types

See Also:

getMIMETypeList

 public static AtomContainer fromMovieImporterSettings(MovieImporter mi) throws StdQTException

Retrieves the current settings from the movie import component..

QuickTime::MovieImportGetSettingsAsAtomContainer

Returns:

an AtomContainer with the current settings.

See Also:

getImportSettingsFromAtomContainer

 public static AtomContainer fromThreeDMediaHandlerObject(ThreeDMediaHandler tdm) throws StdQTException

No QT Documentation.

QuickTime::Media3DGetNamedObjectList()

Returns:

an atom container

See Also:

getNamedObjectList

 public static AtomContainer fromThreeDMediaHandlerRenderer(ThreeDMediaHandler tdm) throws StdQTException

No QT Documentation.

QuickTime::Media3DGetRendererList()

Returns:

an atom container

See Also:

getRendererList

 public static AtomContainer fromCompressionDialog(CompressionDialog cd) throws StdQTException

Retrieves the current configuration from the dialog

QuickTime::SCGetSettingsAsAtomContainer()

Returns:

the settings

See Also:

getSettings

 public AtomData getAtomData(Atom atom) throws StdQTException

Retrieves a pointer to the atom data for the specifiec leaf atom.

QuickTime::QTGetAtomDataPtr

Parameters:

atom - (offset) for AtomContainers this is an "atom" that acts as the offset

 public int getNextChildType(Atom parentAtom,
                             int currentChildType) throws StdQTException

This method allows you to retrieve the next atom data type in a specified atom's child list.

QuickTime::QTGetNextChildType

Parameters:

parentAtom - Specifies the parent atom within this container.

currentChildType - Specifies an atom data type.

Returns:

the found child type.

 public int countChildrenOfType(Atom parentAtom,
                                int childType) throws StdQTException

This method allows you to determine the number of items of a given type in a parent atom's child list.

QuickTime::QTCountChildrenOfType

Parameters:

parentAtom - Specifies the parent atom within this container.

childType - Specifies the type.

Returns:

the number fo children.

 public Atom findChildByIndex_Atom(Atom parentAtom,
                                   int atomType,
                                   int index) throws StdQTException

This method allows you to search for a particular atom within an atom's child list.

QuickTime::QTFindChildByIndex

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the child to be found.

index - Specifies the index of a child of type atomType to be found.

Returns:

the found atom.

 public int findChildByIndex_id(Atom parentAtom,
                                int atomType,
                                int index) throws StdQTException

This method allows you to search for a particular atom within an atom's child list.

QuickTime::QTFindChildByIndex

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the child to be found.

index - Specifies the index of a child of type atomType to be found.

Returns:

the atom's id if it is found.

 public Atom findChildByID_Atom(Atom parentAtom,
                                int atomType,
                                int id) throws StdQTException

This method allows you to search for a particular atom within an atom's child list.

QuickTime::QTFindChildByID

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the child to be found.

id - Specifies the ID of a child of type atomType to be found.

Returns:

the found atom.

 public int findChildByID_index(Atom parentAtom,
                                int atomType,
                                int id) throws StdQTException

This method allows you to search for a particular atom within an atom's child list.

QuickTime::QTFindChildByID

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the child to be found.

id - Specifies the ID of a child of type atomType to be found.

Returns:

the atom's index if it is found.

 public Atom nextChildAnyType(Atom parentAtom,
                              Atom currentChild) throws StdQTException

This method allows you to retrieve all of a parent atom's children one by one, regardless of their type's and id's.

QuickTime::QTNextChildAnyType

Parameters:

parentAtom - Specifies the parent atom within this container.

currentChild - Specifies the current child atom of parentAtom.

Returns:

the QTAtom which is used to return the next child following currentChild in parentAtom's child list.

 public void setAtomData(Atom atom,
                         QTHandleRef data) throws StdQTException

This method allows you to set a leaf atom's data.

QuickTime::QTSetAtomData

Parameters:

atom - Specifies the atom within this container.

data - Contains the data for the atom.

 public void setAtomData(Atom atom,
                         QTPointerRef data) throws StdQTException

This method allows you to set a leaf atom's data.

QuickTime::QTSetAtomData

Parameters:

atom - Specifies the atom within this container.

data - Contains the data for the atom.

 public void setAtomData(Atom atom,
                         QTByteObject data) throws StdQTException

This method allows you to set a leaf atom's data.

QuickTime::QTSetAtomData

Parameters:

atom - Specifies the atom within this container.

data - Contains the data for the atom.

 public void setAtomData(Atom atom,
                         int data) throws StdQTException

This method allows you to set a leaf atom's data.

QuickTime::QTSetAtomData

Parameters:

atom - Specifies the atom within this container.

data - Contains the data for the atom. This value will be endian flipped if required.

 public void setAtomData(Atom atom,
                         short data) throws StdQTException

This method allows you to set a leaf atom's data.

QuickTime::QTSetAtomData

Parameters:

atom - Specifies the atom within this container.

data - Contains the data for the atom. This value will be endian flipped if required.

 public QTHandle copyAtomDataToHandle(Atom atom) throws QTException

This method returns a leaf atom's data.

QuickTime::QTCopyAtomDataToHandle

Parameters:

atom - Specifies the atom within this container.

Returns:

A QTHandle object containing the leaf atom's data.

 public int copyAtomDataToPtr(Atom atom,
                              boolean sizeOrLessOK,
                              QTPointer data) throws StdQTException

This method returns a leaf atom's data to the buffer pointed to by the data object.

QuickTime::QTCopyAtomDataToPtr

Parameters:

atom - Specifies the atom within this container.

sizeOrLessOK - True indicates that it is OK to receive less data than specified by the size of the data Pointer.

data - A QTPointer object containing the buffer for the leaf atom's data.

Returns:

the actual number of bytes retrieved.

 public int getAtomType(Atom atom) throws StdQTException

This method returns the type of a given atom.

QuickTime::QTGetAtomTypeAndID

Parameters:

atom - Specifies the atom within this container.

Returns:

the type of a given atom

 public int getAtomID(Atom atom) throws StdQTException

This method returns the id of a given atom.

QuickTime::QTGetAtomTypeAndID

Parameters:

atom - Specifies the atom within this container.

Returns:

the id of a given atom.

 public AtomContainer copyAtom(Atom atom) throws StdQTException

This method allows a complete copy of an atom and all of its children to be extracted from its container and be placed in an new atom data structure.

QuickTime::QTCopyAtom

Parameters:

atom - Specifies the atom within this container.

Returns:

a new AtomContainer that contains the copy of the specifed atom..

 public Atom insertChild(Atom parentAtom,
                         int atomType,
                         int id,
                         int index) throws QTException

This method creates a new empty child atom for parentAtom.

QuickTime::QTInsertChild

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the new atom which is to be inserted.

id - Specifies the ID of the new atom which is to be inserted.

index - Specifies the index of the new atom for its type within the parent atom's child list.

Returns:

The new atom.

 public Atom insertChild(Atom parentAtom,
                         int atomType,
                         int id,
                         int index,
                         QTByteObject data) throws StdQTException

This method creates a new child atom for parentAtom.

QuickTime::QTInsertChild

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the new atom which is to be inserted.

id - Specifies the ID of the new atom which is to be inserted.

index - Specifies the index of the new atom for its type within the parent atom's child list.

data - A QTByteObject that contains the data of the specifed atom.

Returns:

The new atom.

 public Atom insertChild(Atom parentAtom,
                         int atomType,
                         int id,
                         int index,
                         QTPointerRef data) throws StdQTException

This method creates a new child atom for parentAtom.

QuickTime::QTInsertChild

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the new atom which is to be inserted.

id - Specifies the ID of the new atom which is to be inserted.

index - Specifies the index of the new atom for its type within the parent atom's child list.

data - A QTPointerRef object contains the data of the specifed atom.

Returns:

The new atom.

 public Atom insertChild(Atom parentAtom,
                         int atomType,
                         int id,
                         int index,
                         QTHandleRef data) throws StdQTException

This method creates a new child atom for parentAtom.

QuickTime::QTInsertChild

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the new atom which is to be inserted.

id - Specifies the ID of the new atom which is to be inserted.

index - Specifies the index of the new atom for its type within the parent atom's child list.

data - A QTHandleRef object contains the data of the specifed atom.

Returns:

The new atom.

 public Atom insertChild(Atom parentAtom,
                         int atomType,
                         int id,
                         int index,
                         int intValue) throws StdQTException

This method creates a new child atom for parentAtom.

QuickTime::QTInsertChild

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the new atom which is to be inserted.

id - Specifies the ID of the new atom which is to be inserted.

index - Specifies the index of the new atom for its type within the parent atom's child list.

intValue - Specifies the integer data of the specified atom. This value will be endian flipped if required.

Returns:

The new atom.

 public Atom insertChild(Atom parentAtom,
                         int atomType,
                         int id,
                         int index,
                         short shortValue) throws StdQTException

This method creates a new child atom for parentAtom.

QuickTime::QTInsertChild

Parameters:

parentAtom - Specifies the parent atom within this container.

atomType - Specifies the type of the new atom which is to be inserted.

id - Specifies the ID of the new atom which is to be inserted.

index - Specifies the index of the new atom for its type within the parent atom's child list.

shortValue - Specifies the integer data of the specified atom. This value will be endian flipped if required.

Returns:

The new atom.

 public void insertChildren(Atom parentAtom,
                            AtomContainer childrenContainer) throws StdQTException

This method inserts all of the atoms in childrenContainer as child atoms of the atom specified by the parentAtom.

QuickTime::QTInsertChildren

Parameters:

parentAtom - Specifies the parent atom within this container.

childrenContainer - Specifies the atom data structure which contains all of the children to be inserted.

 public void removeAtom(Atom atom) throws StdQTException

This method removes an atom and all of its children from an atom data structure.

QuickTime::QTRemoveAtom

Parameters:

atom - Specifies the atom whitin this atom container which is to be removed.

 public void removeChildren(Atom atom) throws StdQTException

This method removes all of the children of an atom.

QuickTime::QTRemoveChildren

Parameters:

atom - Specifies the atom whitin this atom container which is to be removed.

 public void replaceAtom(Atom targetAtom,
                         AtomContainer replacementContainer,
                         Atom replacementAtom) throws StdQTException

This method replaces an atom and all of its children with a different atom and all of its children.

QuickTime::QTReplaceAtom

Parameters:

targetAtom - Specifies the atom whitin this atom container which is to be replaced.

replacementContainer - Specifies the atom data structure which contains replacementAtom.

replacementAtom - Specifies the atom within replacementContainer which replaces targetAtom.

 public void swapAtoms(Atom atom1,
                       Atom atom2) throws StdQTException

This method swaps two atoms within an atomData structure.

QuickTime::QTSwapAtoms

Parameters:

atom1 - Specifies an atom whitin this container which is to be swapped with atom2.

atom2 - Specifies the atom whitin this container which is to be swapped with atom1.

 public void setAtomID(Atom atom,
                       int newID) throws StdQTException

This method allows you to change the ID of an atom.

QuickTime::QTSetAtomID

Parameters:

atom - Specifies an atom whitin this container which is to be changed.

newID - Specifies the new ID for the atom.

 public void iTextAddString(Atom parentAtom,
                            int theRegionCode,
                            String theString) throws StdQTException

No QT Documentation.

QuickTime::ITextAddString

Parameters:

theString - a String must be specified.

 public void iTextRemoveString(Atom parentAtom,
                               int theRegionCode,
                               int flags) throws StdQTException

No QT Documentation.

QuickTime::ITextRemoveString

 public IStringInfo iTextGetString(Atom parentAtom,
                                   int requestedRegion) throws StdQTException

No QT Documentation.

QuickTime::ITextGetString

All Packages  Class Hierarchy  This Package  Previous  Next  Index